Read(Byte[],Int32,Int32,Boolean) Method

Read data from the stream until a byte array is filled.

[Visual Basic]
Overloads Public Function Read( _
   ByVal buffer() As Byte, _
   ByVal offset As Integer, _
   ByVal count As Integer, _
   ByVal fill As Boolean _
) As Integer

[C#]
public int Read( 
   byte[] buffer,
   int offset,
   int count,
   bool fill
);

[C++]
public: int Read( 
   byte[]* buffer,
   int offset,
   int count,
   bool fill
) 

[C++/CLI]
public:
int Read( 
   bytearray<buffer>^ buffer,
   int offset,
   int count,
   bool fill
) 

Parameters

buffer

The storage location for the received data.

offset

The zero-based position in the buffer at which to store the received data.

count

The exact number of bytes to read.

fill

Always true, use this version of Read to completely fill the buffer

Return Type

The total number of bytes read into the buffer. This will either be the value of the count parameter, or zero if the stream has closed.

Exceptions

Remarks

This method reads data from the stream and returns when the provided buffer is completely full or end of stream is reached. This method is a good way to read fixed-length data. An example of this is with HTTP chunking, which occurs when the server breaks up the HTTP response into fixed-size chunks. Each chunk is preceded with a hexidecimal value notifying the receiver of the size of the data chunk to follow. Initialize a byte array to this value, then call this method to fill the byte array.

Requirements

Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

See Also

SegmentedStream Class  | SegmentedStream Members  | Overload List